<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /**<a name="line.1"></a>
<FONT color="green">002</FONT>     *<a name="line.2"></a>
<FONT color="green">003</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.3"></a>
<FONT color="green">004</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.4"></a>
<FONT color="green">005</FONT>     * this work for additional information regarding copyright ownership.<a name="line.5"></a>
<FONT color="green">006</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.6"></a>
<FONT color="green">007</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.7"></a>
<FONT color="green">008</FONT>     * the License.  You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT>     *<a name="line.9"></a>
<FONT color="green">010</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT>     *<a name="line.11"></a>
<FONT color="green">012</FONT>     *  Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT>     *  distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT>     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT>     *  See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT>     *  limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT>     */<a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.dbcp.managed;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import org.apache.commons.dbcp.DelegatingConnection;<a name="line.20"></a>
<FONT color="green">021</FONT>    import org.apache.commons.pool.ObjectPool;<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>    import java.sql.Connection;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.sql.SQLException;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    /**<a name="line.26"></a>
<FONT color="green">027</FONT>     * ManagedConnection is responsible for managing a database connection in a transactional environment<a name="line.27"></a>
<FONT color="green">028</FONT>     * (typically called "Container Managed").  A managed connection operates like any other connection<a name="line.28"></a>
<FONT color="green">029</FONT>     * when no global transaction (a.k.a. XA transaction or JTA Transaction) is in progress.  When a<a name="line.29"></a>
<FONT color="green">030</FONT>     * global transaction is active a single physical connection to the database is used by all<a name="line.30"></a>
<FONT color="green">031</FONT>     * ManagedConnections accessed in the scope of the transaction.  Connection sharing means that all<a name="line.31"></a>
<FONT color="green">032</FONT>     * data access during a transaction has a consistent view of the database.  When the global transaction<a name="line.32"></a>
<FONT color="green">033</FONT>     * is committed or rolled back the enlisted connections are committed or rolled back.  Typically upon<a name="line.33"></a>
<FONT color="green">034</FONT>     * transaction completion, a connection returns to the auto commit setting in effect before being<a name="line.34"></a>
<FONT color="green">035</FONT>     * enlisted in the transaction, but some vendors do not properly implement this.<a name="line.35"></a>
<FONT color="green">036</FONT>     *<a name="line.36"></a>
<FONT color="green">037</FONT>     * When enlisted in a transaction the setAutoCommit(), commit(), rollback(), and setReadOnly() methods<a name="line.37"></a>
<FONT color="green">038</FONT>     * throw a SQLException.  This is necessary to assure that the transaction completes as a single unit.<a name="line.38"></a>
<FONT color="green">039</FONT>     *<a name="line.39"></a>
<FONT color="green">040</FONT>     * @author Dain Sundstrom<a name="line.40"></a>
<FONT color="green">041</FONT>     * @version $Revision$<a name="line.41"></a>
<FONT color="green">042</FONT>     */<a name="line.42"></a>
<FONT color="green">043</FONT>    public class ManagedConnection extends DelegatingConnection {<a name="line.43"></a>
<FONT color="green">044</FONT>        private final ObjectPool pool;<a name="line.44"></a>
<FONT color="green">045</FONT>        private final TransactionRegistry transactionRegistry;<a name="line.45"></a>
<FONT color="green">046</FONT>        private final boolean accessToUnderlyingConnectionAllowed;<a name="line.46"></a>
<FONT color="green">047</FONT>        private TransactionContext transactionContext;<a name="line.47"></a>
<FONT color="green">048</FONT>        private boolean isSharedConnection;<a name="line.48"></a>
<FONT color="green">049</FONT>    <a name="line.49"></a>
<FONT color="green">050</FONT>        public ManagedConnection(ObjectPool pool, TransactionRegistry transactionRegistry, boolean accessToUnderlyingConnectionAllowed) throws SQLException {<a name="line.50"></a>
<FONT color="green">051</FONT>            super(null);<a name="line.51"></a>
<FONT color="green">052</FONT>            this.pool = pool;<a name="line.52"></a>
<FONT color="green">053</FONT>            this.transactionRegistry = transactionRegistry;<a name="line.53"></a>
<FONT color="green">054</FONT>            this.accessToUnderlyingConnectionAllowed = accessToUnderlyingConnectionAllowed;<a name="line.54"></a>
<FONT color="green">055</FONT>            updateTransactionStatus();<a name="line.55"></a>
<FONT color="green">056</FONT>        }<a name="line.56"></a>
<FONT color="green">057</FONT>    <a name="line.57"></a>
<FONT color="green">058</FONT>        protected void checkOpen() throws SQLException {<a name="line.58"></a>
<FONT color="green">059</FONT>            super.checkOpen();<a name="line.59"></a>
<FONT color="green">060</FONT>            updateTransactionStatus();<a name="line.60"></a>
<FONT color="green">061</FONT>        }<a name="line.61"></a>
<FONT color="green">062</FONT>    <a name="line.62"></a>
<FONT color="green">063</FONT>        private void updateTransactionStatus() throws SQLException {<a name="line.63"></a>
<FONT color="green">064</FONT>            // if there is a is an active transaction context, assure the transaction context hasn't changed<a name="line.64"></a>
<FONT color="green">065</FONT>            if (transactionContext != null) {<a name="line.65"></a>
<FONT color="green">066</FONT>                if (transactionContext.isActive()) {<a name="line.66"></a>
<FONT color="green">067</FONT>                    if (transactionContext != transactionRegistry.getActiveTransactionContext()) {<a name="line.67"></a>
<FONT color="green">068</FONT>                        throw new SQLException("Connection can not be used while enlisted in another transaction");<a name="line.68"></a>
<FONT color="green">069</FONT>                    }<a name="line.69"></a>
<FONT color="green">070</FONT>                    return;<a name="line.70"></a>
<FONT color="green">071</FONT>                } else {<a name="line.71"></a>
<FONT color="green">072</FONT>                    // transaction should have been cleared up by TransactionContextListener, but in<a name="line.72"></a>
<FONT color="green">073</FONT>                    // rare cases another lister could have registered which uses the connection before<a name="line.73"></a>
<FONT color="green">074</FONT>                    // our listener is called.  In that rare case, trigger the transaction complete call now<a name="line.74"></a>
<FONT color="green">075</FONT>                    transactionComplete();<a name="line.75"></a>
<FONT color="green">076</FONT>                }<a name="line.76"></a>
<FONT color="green">077</FONT>            }<a name="line.77"></a>
<FONT color="green">078</FONT>    <a name="line.78"></a>
<FONT color="green">079</FONT>            // the existing transaction context ended (or we didn't have one), get the active transaction context<a name="line.79"></a>
<FONT color="green">080</FONT>            transactionContext = transactionRegistry.getActiveTransactionContext();<a name="line.80"></a>
<FONT color="green">081</FONT>    <a name="line.81"></a>
<FONT color="green">082</FONT>            // if there is an active transaction context and it already has a shared connection, use it<a name="line.82"></a>
<FONT color="green">083</FONT>            if (transactionContext != null &amp;&amp; transactionContext.getSharedConnection() != null) {<a name="line.83"></a>
<FONT color="green">084</FONT>                // A connection for the connection factory has already been enrolled<a name="line.84"></a>
<FONT color="green">085</FONT>                // in the transaction, replace our delegate with the enrolled connection<a name="line.85"></a>
<FONT color="green">086</FONT>    <a name="line.86"></a>
<FONT color="green">087</FONT>                // return current connection to the pool<a name="line.87"></a>
<FONT color="green">088</FONT>                Connection connection = getDelegateInternal();<a name="line.88"></a>
<FONT color="green">089</FONT>                setDelegate(null);<a name="line.89"></a>
<FONT color="green">090</FONT>                if (connection != null) {<a name="line.90"></a>
<FONT color="green">091</FONT>                    try {<a name="line.91"></a>
<FONT color="green">092</FONT>                        pool.returnObject(connection);<a name="line.92"></a>
<FONT color="green">093</FONT>                    } catch (Exception ignored) {<a name="line.93"></a>
<FONT color="green">094</FONT>                        // whatever... try to invalidate the connection<a name="line.94"></a>
<FONT color="green">095</FONT>                        try {<a name="line.95"></a>
<FONT color="green">096</FONT>                            pool.invalidateObject(connection);<a name="line.96"></a>
<FONT color="green">097</FONT>                        } catch (Exception ignore) {<a name="line.97"></a>
<FONT color="green">098</FONT>                            // no big deal<a name="line.98"></a>
<FONT color="green">099</FONT>                        }<a name="line.99"></a>
<FONT color="green">100</FONT>                    }<a name="line.100"></a>
<FONT color="green">101</FONT>                }<a name="line.101"></a>
<FONT color="green">102</FONT>    <a name="line.102"></a>
<FONT color="green">103</FONT>                // add a listener to the transaction context<a name="line.103"></a>
<FONT color="green">104</FONT>                transactionContext.addTransactionContextListener(new CompletionListener());<a name="line.104"></a>
<FONT color="green">105</FONT>    <a name="line.105"></a>
<FONT color="green">106</FONT>                // set our delegate to the shared connection<a name="line.106"></a>
<FONT color="green">107</FONT>                setDelegate(transactionContext.getSharedConnection());<a name="line.107"></a>
<FONT color="green">108</FONT>    <a name="line.108"></a>
<FONT color="green">109</FONT>                // remember that we are using a shared connection so it can be cleared after the<a name="line.109"></a>
<FONT color="green">110</FONT>                // transaction completes<a name="line.110"></a>
<FONT color="green">111</FONT>                isSharedConnection = true;<a name="line.111"></a>
<FONT color="green">112</FONT>            } else {<a name="line.112"></a>
<FONT color="green">113</FONT>                // if our delegate is null, create one<a name="line.113"></a>
<FONT color="green">114</FONT>                if (getDelegateInternal() == null) {<a name="line.114"></a>
<FONT color="green">115</FONT>                    try {<a name="line.115"></a>
<FONT color="green">116</FONT>                        // borrow a new connection from the pool<a name="line.116"></a>
<FONT color="green">117</FONT>                        Connection connection = (Connection) pool.borrowObject();<a name="line.117"></a>
<FONT color="green">118</FONT>                        setDelegate(connection);<a name="line.118"></a>
<FONT color="green">119</FONT>                    } catch (Exception e) {<a name="line.119"></a>
<FONT color="green">120</FONT>                        throw (SQLException) new SQLException("Unable to acquire a new connection from the pool").initCause(e);<a name="line.120"></a>
<FONT color="green">121</FONT>                    }<a name="line.121"></a>
<FONT color="green">122</FONT>                }<a name="line.122"></a>
<FONT color="green">123</FONT>    <a name="line.123"></a>
<FONT color="green">124</FONT>                // if we have a transaction, out delegate becomes the shared delegate<a name="line.124"></a>
<FONT color="green">125</FONT>                if (transactionContext != null) {<a name="line.125"></a>
<FONT color="green">126</FONT>                    // add a listener to the transaction context<a name="line.126"></a>
<FONT color="green">127</FONT>                    transactionContext.addTransactionContextListener(new CompletionListener());<a name="line.127"></a>
<FONT color="green">128</FONT>    <a name="line.128"></a>
<FONT color="green">129</FONT>                    // register our connection as the shared connection<a name="line.129"></a>
<FONT color="green">130</FONT>                    try {<a name="line.130"></a>
<FONT color="green">131</FONT>                        transactionContext.setSharedConnection(getDelegateInternal());<a name="line.131"></a>
<FONT color="green">132</FONT>                    } catch (SQLException e) {<a name="line.132"></a>
<FONT color="green">133</FONT>                        // transaction is hosed<a name="line.133"></a>
<FONT color="green">134</FONT>                        transactionContext = null;<a name="line.134"></a>
<FONT color="green">135</FONT>                        throw e;<a name="line.135"></a>
<FONT color="green">136</FONT>                    }<a name="line.136"></a>
<FONT color="green">137</FONT>                }<a name="line.137"></a>
<FONT color="green">138</FONT>            }<a name="line.138"></a>
<FONT color="green">139</FONT>        }<a name="line.139"></a>
<FONT color="green">140</FONT>    <a name="line.140"></a>
<FONT color="green">141</FONT>        public void close() throws SQLException {<a name="line.141"></a>
<FONT color="green">142</FONT>            if (!_closed) {<a name="line.142"></a>
<FONT color="green">143</FONT>                try {<a name="line.143"></a>
<FONT color="green">144</FONT>                    // don't actually close the connection if in a transaction<a name="line.144"></a>
<FONT color="green">145</FONT>                    // the connection will be closed by the transactionComplete method<a name="line.145"></a>
<FONT color="green">146</FONT>                    if (transactionContext == null) {<a name="line.146"></a>
<FONT color="green">147</FONT>                        getDelegateInternal().close();<a name="line.147"></a>
<FONT color="green">148</FONT>                    }<a name="line.148"></a>
<FONT color="green">149</FONT>                } finally {<a name="line.149"></a>
<FONT color="green">150</FONT>                    _closed = true;<a name="line.150"></a>
<FONT color="green">151</FONT>                }<a name="line.151"></a>
<FONT color="green">152</FONT>            }<a name="line.152"></a>
<FONT color="green">153</FONT>        }<a name="line.153"></a>
<FONT color="green">154</FONT>    <a name="line.154"></a>
<FONT color="green">155</FONT>        /**<a name="line.155"></a>
<FONT color="green">156</FONT>         * Delegates to {@link ManagedConnection#transactionComplete()} <a name="line.156"></a>
<FONT color="green">157</FONT>         * for transaction completion events. <a name="line.157"></a>
<FONT color="green">158</FONT>         */<a name="line.158"></a>
<FONT color="green">159</FONT>        protected class CompletionListener implements TransactionContextListener {<a name="line.159"></a>
<FONT color="green">160</FONT>            public void afterCompletion(TransactionContext completedContext, boolean commited) {<a name="line.160"></a>
<FONT color="green">161</FONT>                if (completedContext == transactionContext) {<a name="line.161"></a>
<FONT color="green">162</FONT>                    transactionComplete();<a name="line.162"></a>
<FONT color="green">163</FONT>                }<a name="line.163"></a>
<FONT color="green">164</FONT>            }<a name="line.164"></a>
<FONT color="green">165</FONT>        }<a name="line.165"></a>
<FONT color="green">166</FONT>    <a name="line.166"></a>
<FONT color="green">167</FONT>        protected void transactionComplete() {<a name="line.167"></a>
<FONT color="green">168</FONT>            transactionContext = null;<a name="line.168"></a>
<FONT color="green">169</FONT>    <a name="line.169"></a>
<FONT color="green">170</FONT>            // if we were using a shared connection, clear the reference now that the transaction has completed<a name="line.170"></a>
<FONT color="green">171</FONT>            if (isSharedConnection) {<a name="line.171"></a>
<FONT color="green">172</FONT>                // for now, just set the delegate to null, it will be created later if needed<a name="line.172"></a>
<FONT color="green">173</FONT>                setDelegate(null);<a name="line.173"></a>
<FONT color="green">174</FONT>                isSharedConnection = false;<a name="line.174"></a>
<FONT color="green">175</FONT>            }<a name="line.175"></a>
<FONT color="green">176</FONT>    <a name="line.176"></a>
<FONT color="green">177</FONT>            // if this connection was closed during the transaction and there is still a delegate present close it<a name="line.177"></a>
<FONT color="green">178</FONT>            Connection delegate = getDelegateInternal();<a name="line.178"></a>
<FONT color="green">179</FONT>            if (_closed &amp;&amp; delegate != null) {<a name="line.179"></a>
<FONT color="green">180</FONT>                try {<a name="line.180"></a>
<FONT color="green">181</FONT>                    setDelegate(null);<a name="line.181"></a>
<FONT color="green">182</FONT>    <a name="line.182"></a>
<FONT color="green">183</FONT>                    // don't actually close the connection if in a transaction<a name="line.183"></a>
<FONT color="green">184</FONT>                    if (!delegate.isClosed()) {<a name="line.184"></a>
<FONT color="green">185</FONT>                        // don't use super.close() because it calls passivate() which marks the<a name="line.185"></a>
<FONT color="green">186</FONT>                        // the connection as closed without returning it to the pool<a name="line.186"></a>
<FONT color="green">187</FONT>                        delegate.close();<a name="line.187"></a>
<FONT color="green">188</FONT>                    }<a name="line.188"></a>
<FONT color="green">189</FONT>                } catch (SQLException ignored) {<a name="line.189"></a>
<FONT color="green">190</FONT>                    // not a whole lot we can do here as connection is closed<a name="line.190"></a>
<FONT color="green">191</FONT>                    // and this is a transaction callback so there is no<a name="line.191"></a>
<FONT color="green">192</FONT>                    // way to report the error<a name="line.192"></a>
<FONT color="green">193</FONT>                } finally {<a name="line.193"></a>
<FONT color="green">194</FONT>                    _closed = true;<a name="line.194"></a>
<FONT color="green">195</FONT>                }<a name="line.195"></a>
<FONT color="green">196</FONT>            }<a name="line.196"></a>
<FONT color="green">197</FONT>    <a name="line.197"></a>
<FONT color="green">198</FONT>        }<a name="line.198"></a>
<FONT color="green">199</FONT>    <a name="line.199"></a>
<FONT color="green">200</FONT>        //<a name="line.200"></a>
<FONT color="green">201</FONT>        // The following methods can't be used while enlisted in a transaction<a name="line.201"></a>
<FONT color="green">202</FONT>        //<a name="line.202"></a>
<FONT color="green">203</FONT>    <a name="line.203"></a>
<FONT color="green">204</FONT>        public void setAutoCommit(boolean autoCommit) throws SQLException {<a name="line.204"></a>
<FONT color="green">205</FONT>            if (transactionContext != null) {<a name="line.205"></a>
<FONT color="green">206</FONT>                throw new SQLException("Auto-commit can not be set while enrolled in a transaction");<a name="line.206"></a>
<FONT color="green">207</FONT>            }<a name="line.207"></a>
<FONT color="green">208</FONT>            super.setAutoCommit(autoCommit);<a name="line.208"></a>
<FONT color="green">209</FONT>        }<a name="line.209"></a>
<FONT color="green">210</FONT>    <a name="line.210"></a>
<FONT color="green">211</FONT>    <a name="line.211"></a>
<FONT color="green">212</FONT>        public void commit() throws SQLException {<a name="line.212"></a>
<FONT color="green">213</FONT>            if (transactionContext != null) {<a name="line.213"></a>
<FONT color="green">214</FONT>                throw new SQLException("Commit can not be set while enrolled in a transaction");<a name="line.214"></a>
<FONT color="green">215</FONT>            }<a name="line.215"></a>
<FONT color="green">216</FONT>            super.commit();<a name="line.216"></a>
<FONT color="green">217</FONT>        }<a name="line.217"></a>
<FONT color="green">218</FONT>    <a name="line.218"></a>
<FONT color="green">219</FONT>        public void rollback() throws SQLException {<a name="line.219"></a>
<FONT color="green">220</FONT>            if (transactionContext != null) {<a name="line.220"></a>
<FONT color="green">221</FONT>                throw new SQLException("Commit can not be set while enrolled in a transaction");<a name="line.221"></a>
<FONT color="green">222</FONT>            }<a name="line.222"></a>
<FONT color="green">223</FONT>            super.rollback();<a name="line.223"></a>
<FONT color="green">224</FONT>        }<a name="line.224"></a>
<FONT color="green">225</FONT>    <a name="line.225"></a>
<FONT color="green">226</FONT>    <a name="line.226"></a>
<FONT color="green">227</FONT>        public void setReadOnly(boolean readOnly) throws SQLException {<a name="line.227"></a>
<FONT color="green">228</FONT>            if (transactionContext != null) {<a name="line.228"></a>
<FONT color="green">229</FONT>                throw new SQLException("Read-only can not be set while enrolled in a transaction");<a name="line.229"></a>
<FONT color="green">230</FONT>            }<a name="line.230"></a>
<FONT color="green">231</FONT>            super.setReadOnly(readOnly);<a name="line.231"></a>
<FONT color="green">232</FONT>        }<a name="line.232"></a>
<FONT color="green">233</FONT>    <a name="line.233"></a>
<FONT color="green">234</FONT>        //<a name="line.234"></a>
<FONT color="green">235</FONT>        // Methods for accessing the delegate connection<a name="line.235"></a>
<FONT color="green">236</FONT>        //<a name="line.236"></a>
<FONT color="green">237</FONT>    <a name="line.237"></a>
<FONT color="green">238</FONT>        /**<a name="line.238"></a>
<FONT color="green">239</FONT>         * If false, getDelegate() and getInnermostDelegate() will return null.<a name="line.239"></a>
<FONT color="green">240</FONT>         * @return if false, getDelegate() and getInnermostDelegate() will return null<a name="line.240"></a>
<FONT color="green">241</FONT>         */<a name="line.241"></a>
<FONT color="green">242</FONT>        public boolean isAccessToUnderlyingConnectionAllowed() {<a name="line.242"></a>
<FONT color="green">243</FONT>            return accessToUnderlyingConnectionAllowed;<a name="line.243"></a>
<FONT color="green">244</FONT>        }<a name="line.244"></a>
<FONT color="green">245</FONT>    <a name="line.245"></a>
<FONT color="green">246</FONT>        public Connection getDelegate() {<a name="line.246"></a>
<FONT color="green">247</FONT>            if (isAccessToUnderlyingConnectionAllowed()) {<a name="line.247"></a>
<FONT color="green">248</FONT>                return getDelegateInternal();<a name="line.248"></a>
<FONT color="green">249</FONT>            } else {<a name="line.249"></a>
<FONT color="green">250</FONT>                return null;<a name="line.250"></a>
<FONT color="green">251</FONT>            }<a name="line.251"></a>
<FONT color="green">252</FONT>        }<a name="line.252"></a>
<FONT color="green">253</FONT>    <a name="line.253"></a>
<FONT color="green">254</FONT>        public Connection getInnermostDelegate() {<a name="line.254"></a>
<FONT color="green">255</FONT>            if (isAccessToUnderlyingConnectionAllowed()) {<a name="line.255"></a>
<FONT color="green">256</FONT>                return super.getInnermostDelegateInternal();<a name="line.256"></a>
<FONT color="green">257</FONT>            } else {<a name="line.257"></a>
<FONT color="green">258</FONT>                return null;<a name="line.258"></a>
<FONT color="green">259</FONT>            }<a name="line.259"></a>
<FONT color="green">260</FONT>        }<a name="line.260"></a>
<FONT color="green">261</FONT>    }<a name="line.261"></a>




























































</PRE>
</BODY>
</HTML>
